All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.sun.java.swing.text.TextAction 

java.lang.Object
   |
   +----com.sun.java.swing.AbstractAction
           |
           +----com.sun.java.swing.text.TextAction
public abstract class TextAction
extends AbstractAction
An Action implementation useful for key bindings that are shared across a number of different text components. Because the action is shared, it must have a way of getting it's target to act upon. This class provides support to try and find a text component to operate on. The preferred way of getting the component to act upon is through the ActionEvent that is received. If the Object returned by getSource can be narrowed to a text component, it will be used. If the action event is null or can't be narrowed, the last focused text component is tried. This is determined by being used in conjunction with a JTextController which arranges to share that information with a TextAction.

Warning: serialized objects of this class will not be compatible with future swing releases. The current serialization support is appropriate for short term storage or RMI between Swing1.0 applications. It will not be possible to load serialized Swing1.0 objects with future releases of Swing. The JDK1.2 release of Swing will be the compatibility baseline for the serialized form of Swing objects.

Constructor Index

o TextAction(String)
Creates a new JTextAction object.

Method Index

o augmentList(Action[], Action[])
Takes one list of commands and augments it with another list of commands.
o getFocusedComponent()
Fetches the text component that currently has focus.
o getTextComponent(ActionEvent)
Determines the component to use for the action.

Constructors

o TextAction 
 public TextAction(String name)
Creates a new JTextAction object.

Parameters:
name - the name of the action

Methods

o getTextComponent 
 protected final JTextComponent getTextComponent(ActionEvent e)
Determines the component to use for the action. This if fetched from the source of the ActionEvent if it's not null and can be narrowed. Otherwise, the last focused component is used.

Parameters:
e - the ActionEvent
Returns:
the component
o augmentList 
 public static final Action[] augmentList(Action list1[],
                                          Action list2[])
Takes one list of commands and augments it with another list of commands. The second list is considered to be higher priority than the first list and commands with the same name will both lists will only have the dominate command found in the second list in the returned list.

Parameters:
list1 - the first list, may be empty but not null
list2 - the second list, may be empty but not null
Returns:
the augmented list
o getFocusedComponent 
 protected final JTextComponent getFocusedComponent()
Fetches the text component that currently has focus. This allows actions to be shared across text components which is useful for key-bindings where a large set of actions are defined, but generally used the same way across many different components.

Returns:
the component 
All Packages  Class Hierarchy  This Package  Previous  Next  Index